4.2 编辑外部用户(无管理接口用户目录)

基本信息

Path: /api/v1/externalUser/update

Method: POST

接口描述:

注意:该接口文档只针对无管理接口的用户目录,即用户目录数据来源为本地的用户目录

  1. 对于更新接口中的非必须参数,如果不传,不会对该条数据相对应参数进行修改
  2. id、name、userDirectoryId为非编辑字段,用于找到对应的数据
  3. 部分参数,如关联对象ID,需要通过在控制台手动获取,以Chrome浏览器为例,获取方式为F12打开“开发者工具”,在Network中找到对应对象的查询接口手动获取该对象的ID
  4. 用户目录ID,userDirectoryId获取方式,用“开发者工具”过滤请求 userDirectory/queryAll,打开控制台“业务管理”->“用户管理”页面,查看响应体数据获取对应用户目录的ID,也可以通过用户目录查询接口获取ID
  5. 认证策略ID,authComposeId获取方式,用“开发者工具”过滤请求 authCompose/queryAll,在控制台“业务管理”->“认证管理”->“认证策略”页面中打开您新增用户所属的用户目录,找到所属用户目录的认证策略查询接口,查看响应体数据获取对应的认证策略ID
  6. 用户策略ID,userPolicyId获取方式,用“开发者工具”过滤请求 userPolicy/queryUserPolicy,进入控制台“业务管理”->“策略管理”->“用户策略”页面,查看响应体数据获取所需策略的ID
  7. 群组ID,可通过外部用户群组查询接口获取ID
  8. 注意:无管理接口的用户目录下的外部用户不能设置外部ID的数据来源为远端认证服务器获取

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 必须  

Body

根据用户名称编辑

名称 类型 是否必须 默认值 备注 其他信息
name string 必须 用户名称
userDirectoryId string 与userDirectoryName二选一 所属用户目录名称,ID和名称只需传一个即可,都传时以ID为准所属用户目录ID
userDirectoryName string 与userDirectoryId二选一 所属用户目录名称,ID和名称只需传一个即可,都传时以ID为准
displayName string 非必须 显示名。如要调整该字段值,请在fieldDataSource中将displayName字段数据来源修改为'local'
externalId string 非必须 外部ID,不传默认由服务端生成
path string 非必须 所属组织架构
status number 非必须 启用状态,0禁用,1启用。如要调整该字段值,请在fieldDataSource中将status字段数据来源修改为'local'
description string 非必须 描述。如要调整该字段值,请在fieldDataSource中将description字段数据来源修改为'local'
email string 非必须 邮箱。如要调整该字段值,请在fieldDataSource中将email字段数据来源修改为'local'
phone string 非必须 手机号码。如要调整该字段值,请在fieldDataSource中将phone字段数据来源修改为'local'
expiredTime string 非必须 过期时间,时间戳,13位长度,单位毫秒,'0'表示永不过期。如要调整该字段值,请在fieldDataSource中将expiredTime字段数据来源修改为'local'
ext object 非必须 拓展字段
├─fieldDataSource object 非必须 认证时用户数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段
├─├─displayName string 非必须 显示名数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
├─├─description string 非必须 描述数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
├─├─email string 非必须 电子邮件数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
├─├─expiredTime string 非必须 过期时间数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
├─├─phone string 非必须 手机号码数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
├─├─status string 非必须 启用状态数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
inheritGroup number 非必须 是否继承所属组织架构的授权应用:0不继承,1继承,默认继承
roleIdEditWay string 非必须 'set' 角色编辑方式,'set'重置,'append'追加,'delete'删除
roleIdList string[] 非必须 角色ID列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
roleNameList string[] 非必须 角色名列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
resourceGroupIdEditWay string 非必须 'set' 应用分类编辑方式,'set'重置,'append'追加,'delete'删除
resourceGroupIdList string[] 非必须 应用分类ID列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
resourceGroupNameList string[] 非必须 应用分类名列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
resourceIdEditWay string 非必须 'set' 应用编辑方式,'set'重置,'append'追加,'delete'删除
resourceIdList string[] 非必须 应用ID列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
resourceNameList string[] 非必须 应用名列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
authComposeId string 非必须 认证策略ID,默认关联所属用户目录的默认策略,名称与ID只需要传一个即可,都传时以ID为准
authComposeName string 非必须 认证策略名称,不传默认关联所属用户目录的默认策略,名称与ID只需要传一个即可,都传时以ID为准
userPolicyId string 非必须 用户策略ID,不传默认关联默认用户策略,名称与ID只需要传一个即可,都传时以ID为准
userPolicyName string 非必须 用户策略名称,不传默认关联默认用户策略,名称与ID只需要传一个即可,都传时以ID为准
bandIdEditWay string 非必须 'set' 群组编辑方式,'set'重置,'append'追加,'delete'删除
bandIdList string[] 非必须 群组ID列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
bandNameList string[] 非必须 群组名列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准

根据用户ID编辑

名称 类型 是否必须 默认值 备注 其他信息
id string 必须 用户ID
userDirectoryId string 与userDirectoryName二选一 所属用户目录名称,ID和名称只需传一个即可,都传时以ID为准所属用户目录ID
userDirectoryName string 与userDirectoryId二选一 所属用户目录名称,ID和名称只需传一个即可,都传时以ID为准
displayName string 非必须 显示名。如要调整该字段值,请在fieldDataSource中将displayName字段数据来源修改为'local'
externalId string 非必须 外部ID,不传默认由服务端生成
path string 非必须 所属组织架构
status number 非必须 启用状态,0禁用,1启用。如要调整该字段值,请在fieldDataSource中将status字段数据来源修改为'local'
description string 非必须 描述。如要调整该字段值,请在fieldDataSource中将description字段数据来源修改为'local'
email string 非必须 邮箱。如要调整该字段值,请在fieldDataSource中将email字段数据来源修改为'local'
phone string 非必须 手机号码。如要调整该字段值,请在fieldDataSource中将phone字段数据来源修改为'local'
expiredTime string 非必须 过期时间,时间戳,13位长度,单位毫秒,'0'表示永不过期。如要调整该字段值,请在fieldDataSource中将expiredTime字段数据来源修改为'local'
ext object 非必须 拓展字段
├─fieldDataSource object 非必须 认证时用户数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段
├─├─displayName string 非必须 显示名数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录获取该字段
├─├─description string 非必须 描述数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
├─├─email string 非必须 电子邮件数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
├─├─expiredTime string 非必须 过期时间数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
├─├─path string 非必须 所属组织架构数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
├─├─phone string 非必须 手机号码数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
├─├─status string 非必须 启用状态数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
inheritGroup number 非必须 是否继承所属组织架构的授权应用:0不继承,1继承,默认继承
roleIdEditWay string 非必须 'set' 角色编辑方式,'set'重置,'append'追加,'delete'删除
roleIdList string[] 非必须 角色ID列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
roleNameList string[] 非必须 角色名列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
resourceGroupIdEditWay string 非必须 'set' 应用分类编辑方式,'set'重置,'append'追加,'delete'删除
resourceGroupIdList string[] 非必须 应用分类ID列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
resourceGroupNameList string[] 非必须 应用分类名列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
resourceIdEditWay string 非必须 'set' 应用编辑方式,'set'重置,'append'追加,'delete'删除
resourceIdList string[] 非必须 应用ID列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
resourceNameList string[] 非必须 应用名列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
authComposeId string 非必须 认证策略ID,默认关联所属用户目录的默认策略,名称与ID只需要传一个即可,都传时以ID为准
authComposeName string 非必须 认证策略名称,不传默认关联所属用户目录的默认策略,名称与ID只需要传一个即可,都传时以ID为准
userPolicyId string 非必须 用户策略ID,不传默认关联默认用户策略,名称与ID只需要传一个即可,都传时以ID为准
userPolicyName string 非必须 用户策略名称,不传默认关联默认用户策略,名称与ID只需要传一个即可,都传时以ID为准
bandIdEditWay string 非必须 'set' 群组编辑方式,'set'重置,'append'追加,'delete'删除
bandIdList string[] 非必须 群组ID列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
bandNameList string[] 非必须 群组名列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准

请求示例

{
    "id":"e1ded190-5964-11eb-a9a0-931833117fac",
    "userDirectoryId" : "41d98830-f35f-11eb-9fa6-51583517c5f3",
    "description": "描述信息",
    "email": "test@test.com",
    "expiredTime": "0",
    "ext":{
        "fieldDataSource":{
            "description":"server",
            "email":"server",
            "expiredTime":"server",
            "path":"server",
            "phone":"server",
            "status":"server"
        },
    },
    "roleIdEditWay": "append",
    "roleIdList": ["41d98830-f35f-11eb-9fa6-51583517c5f4"],
    "bandIdEditWay": "append",
    "bandIdList": [ "5559f620-5583-11eb-880a-913383f106f2", "6659f620-5583-11eb-880a-913383f106f2"],
    "status":1,
}

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 错误码,非0表示错误,具体含义请参考错误码定义
data object 必须 返回内容
msg string 必须 描述信息  

返回示例

{
    "code":0,
    "data":{},
    "msg":"请求成功"
}

错误信息

错误提示 错误码
请输入正确的所属组织架构格式:请以“/”开头,组织架构路径不能有连续“/”,且不能以“/”结尾 7201
该输入项目必须是手机号码格式, 如:[国际区号-]手机号,由数字组成,长度为6-20位 7201
该输入项目必须是电子邮箱格式,如:xxx@xx.com 7201
角色编辑方式错误,只允许set重置,append追加,delete删除 7201
应用编辑方式错误,只允许set重置,append追加,delete删除 7201
应用分类编辑方式错误,只允许set重置,append追加,delete删除 7201
参数检查出错 10000001
用户最多关联2000个角色 10000000
所属组织架构路径层级不能超过32级 10000001
用户或用户组织架构最多关联1000个应用 77200007
名称不能为空 10000001
组织架构不能为空 10000001
用户目录不存在 77200001
角色不存在 77200001
应用不存在 77200001
应用分类不存在 77200001
用户不存在 10000000
外部用户不存在 77200001
用户名不允许被编辑 10000000
认证服务器不允许被编辑 10000000
认证策略不存在 10000000
用户策略不存在 77200004
保存失败,关联的角色不存在 77200004
数据已经变动, 请刷新后重试 10000001
保存失败,关联的应用不存在或已被删除 77200004
用户最多关联1000个应用 77200007
外部ID重复,请重新输入 10000000
操作失败 10000000
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-05-18 14:38

results matching ""

    No results matching ""